-----------------------------------------------------------------------------
                                    UTelAdSE
                                 developer docs
                        by Michiel 'El Muerte' Hendriks
                           elmuerte@drunksnipers.com
-----------------------------------------------------------------------------

Contents:
- Extending UTelAdSE
- Shortkeys
...
- Source code
- Contact information

------------------------------ EXTENDING UTELADSE ---------------------------

To extend UTelAdSE with more builtin commands you have to write a new class 
that extends UTelAdSE.UTelAdSEHelper.
Check the UTelAdSEHelper.uc file for information and the file 
DefaultBuiltins.uc for an example implementation

To install the helper you have to edit the server config file and add your 
Helper class:

    [UTelAdSE.UTelAdSE]
    TelnetHelperClasses=Class'UTelAdSE.DefaultBuiltins'
    TelnetHelperClasses=Class'UTelAdSE.UserGroupAdmin'
    TelnetHelperClasses=Class'UTelAdSE.ServerBuiltins'
    TelnetHelperClasses= put your classes here

---------------------------------- SHORT-KEYS -------------------------------
There are two ways for short keys, the first is by using control characters, 
and the second one i by using escape codes. A few control characters can not 
be used:

Control char  | Key | ASCII | 
--------------------------------------
NUL             ^@    0x00    The unreal engine can not read NUL characters
BS              ^H    0x08    The backspace is used to erase characters 
                              from the input
CR              ^M    0x0D    The enter key/carriage return is used for 
                              sending commands
ESC             ^[    0x1B    The escape key is used to capture the escape 
                              codes

When sending an escape code (ESC+key) only the ASCII value of the escaped key 
will be used. So ESC+A will get as short-key value 41. Note that for escape 
codes the case does matter, ESC+A is not the same as ESC+a.

--------------------------------- SOURCE CODE -------------------------------
UTelAdSE is provided under the GPL. The complete source code is available
from the UTelAdSE homepage. Please respect the GPL:
                      http://www.gnu.org/licenses/gpl.txt

----------------------------- CONTACT INFORMATION ---------------------------
ServerAdsSE has been written by Michiel 'El Muerte' Hendriks 
<elmuerte@drunksnipers.com> member of The Drunk Snipers (TDS for short)
If you have any questions you can contact me, but I will not reply to 
questions who's answers can be found in this document.

The latest version of this server add-on can be downloaded from: 
http://www.drunksnipers.com/services/ut/ut2003/UTelAdSE

-----------------------------------------------------------------------------
Michiel 'El Muerte' Hendriks                        elmuerte@drunksnipers.com
The Drunk Snipsers - ICT Solutions                http://www.drunksnipers.com
-----------------------------------------------------------------------------